Description
Remove the file attached to the input document as specified by the 'xpath' parameter. If the 'xpath' point to a blob list then the list will be cleared. If the file to remove is part of a list it will be removed from the list otherwise the 'xpath' should point to a blob property that will be removed. If the save parameter is set the document modification will be automatically saved. Return the document.
Operation id | Blob.RemoveFromDocument |
Aliases | Blob.Remove
|
Category | Files |
Label | Remove File |
Requires | |
Since | |
Parameters
Signature
Inputs | document, documents |
Outputs | document, documents |
Implementation Information
JSON Definition
{
"id" : "Blob.RemoveFromDocument",
"aliases" : [ "Blob.Remove" ],
"label" : "Remove File",
"category" : "Files",
"requires" : null,
"description" : "Remove the file attached to the input document as specified by the 'xpath' parameter. If the 'xpath' point to a blob list then the list will be cleared. If the file to remove is part of a list it will be removed from the list otherwise the 'xpath' should point to a blob property that will be removed. If the save parameter is set the document modification will be automatically saved. Return the document.",
"url" : "Blob.RemoveFromDocument",
"signature" : [ "document", "document", "documents", "documents" ],
"params" : [ {
"name" : "save",
"description" : null,
"type" : "boolean",
"required" : false,
"widget" : null,
"order" : 0,
"values" : [ "true" ]
}, {
"name" : "xpath",
"description" : null,
"type" : "string",
"required" : false,
"widget" : null,
"order" : 0,
"values" : [ "file:content" ]
} ]
}